Add first-class Go hosting docs#950
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
IEvangelist
left a comment
IEvangelist
left a comment
There was a problem hiding this comment.
While I understand that this is a replacement, we do need to restructure this so that it follows the new pattern we recently implemented. Ideally, this will have a sidebar like:
Go
- Get started
- Set up Go in the AppHost
The get started should answer, "what (intro p)", "why (from broad to aspire specficially)", "how (the pieces fit together)", and then step links out to Modeling Go in the AppHost. And it might be a good idea to even show Connect to Go from a consuming resource, which would explain injected config from env var and how to use them - connection properties, etc.
|
We need to merge main into release/13.4 first. |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
It's still a draft PR, do you want it merged now? |
davidfowl
requested review from
aaronpowell,
eerhardt and
maddymontaquila
as code owners
…hosting-docs-13-4
There was a problem hiding this comment.
Pull request overview
This PR replaces the deprecated CommunityToolkit Go integration docs with first-class Aspire Go hosting documentation and updates navigation, redirects, and package-to-doc mappings accordingly.
Changes:
- Adds new Go get-started and AppHost setup documentation under
integrations/frameworks/go/. - Updates links and integration metadata from
CommunityToolkit.Aspire.Hosting.GolangtoAspire.Hosting.Go. - Adds redirects and sidebar entries for the new Go docs structure.
Show a summary per file
| File | Description |
|---|---|
src/frontend/src/content/docs/integrations/frameworks/go/go-get-started.mdx |
Adds the new Go integration landing page. |
src/frontend/src/content/docs/integrations/frameworks/go/go-host.mdx |
Adds detailed AppHost setup guidance for Go apps. |
src/frontend/src/content/docs/integrations/frameworks/go-apps.mdx |
Removes the old CommunityToolkit Go integration page. |
src/frontend/config/sidebar/integrations.topics.ts |
Adds a nested Go section for the new docs. |
src/frontend/config/redirects.mjs |
Redirects old Go docs paths to the new get-started page. |
src/frontend/src/data/integration-docs.json |
Maps Go package names to the new docs URL. |
src/frontend/src/data/aspire-integration-names.json |
Adds Aspire.Hosting.Go to integration names. |
src/frontend/src/content/docs/languages-and-runtimes/index.mdx |
Moves Go into official language/runtime guides. |
src/frontend/src/content/docs/get-started/app-host.mdx |
Updates English Go integration package/link references. |
src/frontend/src/content/docs/ja/get-started/app-host.mdx |
Updates Japanese Go integration package/link references. |
src/frontend/src/content/docs/community/thanks.mdx |
Updates the Go community docs link. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 11/11 changed files
- Comments generated: 0
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Summary
Aspire.Hosting.Goguidance.AddGoApp/addGoApp, app directories and package paths, app arguments, module helpers, Delve debugging, publish behavior, private modules, and experimental Go templates.src/frontend/src/content/docs/integrations/frameworks/go-apps.mdxonrelease/13.4.Validation
pnpm --dir .\src\frontend exec prettier --check src/content/docs/integrations/frameworks/go-apps.mdxgit diff --checkpnpm --dir .\src\frontend run check-datapnpm --dir .\src\frontend run test:unit:docsNote:
pnpm --dir .\src\frontend run lintcurrently fails onrelease/13.4intests/unit/llms-txt-twoslash.vitest.test.tswith existing@typescript-eslint/no-unsafe-*errors unrelated to this docs page.